Skip to main content
Version: 2.0

Plugin library

overview​

The plugin system is one of Re: Earth's greatest features. You can extend the functionality of Re:Earth by developing your own plugins or using plugins developed by other users in the community.

For example, displaying a new item in the info box that appears when a marker is selected, or placing an original function widget on the screen, executing processing that cannot be achieved with existing Re: Earth functions. becomes possible.

In the future, we plan to make it possible to use plug-ins to perform calculations for streamlining scene editing and data processing.

The Plugin Library page manages plugins for your project.

55555555555555555555555_1.png

A. It shows how to install the plugin.

B. The Upload Zip File from PC button selects the zip file from your PC to install the plugin.

C. The GitHub public repository button installs the plugin directly from GitHub.

D. The Publish your plugin on the marketplace button allows you to publish your plugin on the marketplace.

E .Under Installed you will see all the plugins installed in the current project.

Idea of plugin​

How to install and remove plugins.​

Installing and removing plugins

Accessing the plugin library​

① Open the project settings screen from the settings button on the dashboard screen.

4.png

② Select “Plugins” from the menu on the left.

tg 1.png

③ Click “Personally Installed” to access the plug-in library.

874 1.png

Install plugin​

There are two ways to install the plugin.

In "Upload Zip File from PC", select the zip file from your PC to install the plug-in. "GitHub Public Repository" installs the plugin directly from GitHub.

Upload Zip file from PC​

① Access the plugin library and select "Upload Zip file from PC".

s 2 (1).png

② Select the Zip file.

sf 1.png

③If you wait for a while and a notification is displayed, the plug-in has been successfully installed.

55 1 (1).png

If an error occurs here, the following causes are possible.

There is an error in the format of reearth.yml.

  • A plugin with the same ID is already installed. Please remove the existing plugin and run the installation again.
  • The ZIP file does not contain reearth.yml or there are multiple directories in the root. Compress a single folder containing reearth.yml or multiple files containing reearth.yml.
  • An invalid ZIP file may be output depending on the application that generates the ZIP file. Please compress using other applications.

GitHub public repository​

s 2 (2).png

② Enter the URL of the GitHub repository.

gf 1.png

③ Click the “Continue” button.

64 1 (1).png

④If you wait for a while and a notification is displayed, the plug-in has been successfully installed.

55 1 (1).png

Remove plugin​

① Access the plugin library and place the cursor on the installed button on the right side of the row where the plugin name is displayed.

874 1 (1).png

② When the "Installed" button changes to "Uninstall", click the Uninstall button.

99 1.png

③ Click the Uninstall button on the displayed pop-up.

45 1.png

④If you wait for a while and a notification is displayed, the plug-in has been successfully deleted.

966666 1.png

If you remove the plugin, the added widgets and blocks will be removed from the scene. If you have already published scenes that use the removed plugin, widgets and blocks will no longer work in the published scenes.